home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / ctg.lha / ctg / README
Encoding:
Text File  |  1995-03-09  |  3.1 KB  |  78 lines
  1.             _______________________________________________________
  2.            /                                                       \
  3.           /                         - CTG -                         \
  4.          /\                 C++ class tree generator                /
  5.         /  \_______________________________________________________/
  6.        /   /                                                      /
  7.        \  /                  for AmigaOS and UNIX                /
  8.         \/______________________________________________________/
  9.  
  10.                   (C) Copyright 1995 by Rainer Koppler
  11.                       E-Mail: rk@gup.uni-linz.ac.at
  12.  
  13.  
  14. 0. Disclaimer
  15.  
  16. This program is Freeware. This means that you may redistribute this package
  17. as long as no fee for the software itself is charged and the copyright notice is
  18. left unchanged and kept together with the rest of this package.
  19. The author takes no responsibility for any damange caused by direct or indirect
  20. usage of this program. You use this software at your own risk.
  21.  
  22.  
  23. 1. Introduction
  24.  
  25. ctg is a useful source text documentation tool for C++ programmers. It reads a
  26. number of C++ source files, extracts class und struct definitions and generates
  27. a graphical representation of the resulting class hierarchy as a PostScript(TM)
  28. source. The output may be constrained to a specified subset of classes according
  29. to the contents of a given configuration file.
  30.  
  31. The initial version of ctg was developed on a SPARCstation (SunOS 4.1.3) with
  32. gcc 2.4.5. The Amiga version was compiled with SAS C++ 6.50 (which caused
  33. several problems due to some restrictions and errors of this immature compiler).
  34.  
  35. This version is intended for usage in the shell. Although there are plans for a
  36. version which also shows class hierarchies in windows with popup menues for
  37. class methods, I probably won't realize them since I don't want to re-implement
  38. SNiFF+ (a great integrated C++ environment for UNIX) on the Amiga.
  39.  
  40.  
  41. 2. Requirements
  42.  
  43. In order to parse C++ source texts accurately ctg uses an external C++ relies
  44. on an external preprocessor. ctg has been tested extensively with cpp of gcc
  45. 2.4.5 (SunOS) and gcc 2.6.3 (Amiga). Theoretically any ANSI-compliant 
  46. preprocessor may be used.
  47.  
  48.  
  49. 3. Distribution contents
  50.  
  51. This distribution of ctg should contain the following files:
  52.  
  53. README ..................... this file
  54.  
  55. c/ctg ...................... Amiga binary
  56.  
  57. doc/ ....................... documentation files
  58.   ctg.man .................. man page as ASCII file with control codes
  59.   ctg.1 .................... troff source for ctg.man
  60.   ctg.frm .................. FrameMaker4(TM) document of ctg.1
  61.   ctg.ps ................... PostScript output of ctg.frm
  62.  
  63. env/ctg.prefs .............. default configuration file
  64.  
  65. examples/ .................. example class trees
  66.   ctg.ps 
  67.   gddt.ps
  68.   GDId.ps
  69.   tkit.ps
  70.  
  71.  
  72. 4. Installation
  73.  
  74. The installation of ctg is simple. Just copy the binary c/ctg to a directory of
  75. your command path and the default configuration env/ctg.prefs to ENVARC: and
  76. ENV:. If you use cpp of gcc without the compilers, don't forget the assignment
  77. GNU: to the root of your alternate compiler system.
  78.